/*
 * Copyright 2016-2022 chronicle.software
 *
 *       https://chronicle.software
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.openhft.chronicle.core.io;

/**
 * An interface for objects that can be synced to underlying media if supported.
 * Implementations can perform a sync operation to ensure data is flushed to the underlying media.
 */
public interface Syncable {

    /**
     * Performs a sync operation if the given object implements the {@code Syncable} interface.
     * This method provides a convenient way to invoke the sync operation on an object without explicitly checking its type.
     *
     * @param o The object to sync, if it implements the {@code Syncable} interface.
     */
    static void syncIfAvailable(Object o) {
        if (o instanceof Syncable)
            ((Syncable) o).sync();
    }

    /**
     * Performs a sync operation up to the point that this handle has read or written.
     * The behavior of this method depends on whether syncing is supported and the underlying implementation.
     * There might be data beyond this point that isn't synced.
     * It may not perform any action if syncing is not supported or has been turned off through configuration.
     */
    void sync();
}
